.. _cmnGnDlgSetup:

cmnGnDlgSetup
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

SYNOPSYS
`````````````
.. code-block:: none

  VT_I4 cmnGnDlgSetup([in] BOOL IsEnable, [out] DWORD nLevel, [in] DWORD nDebugType, [in] VT_HANDLE Handler, [in] LPVOID lParam, [in] VT_STR szDebugFileName)


DESCRIPTION
`````````````


- 디버깅로그를 출력할 방법을 설정 합니다. 디버깅 로그는 출력을 위한 여러가지 방법을 지원합니다. 선택된 디버깅 방법에 따라 사용되는 인자가 다르기 때문에 주의를 요합니다. 디버그 메시지 출력에 DEBUG_OUT_CALLBACK 모드를 사용하실 경우에는 cmnGnDlgGetLastMessage 함수를 콜백 함수내부에 추가하셔서 사용하시면 됩니다.


PARAMETER
`````````````

- IsEnable : 디버그 다이얼로그의 사용여부를 정합니다.

+---------------+----------------------------------+
| Value         | Meaning                          |
+===============+==================================+
| DEBUG_DISABLE | 디버그 모드를 사용하지 않습니다. |
+---------------+----------------------------------+
| DEBUG_ENABLE  | 디버그 모드를 사용합니다.        |
+---------------+----------------------------------+

- nLevel : 디버깅 레벨을 설정합니다.

+---------------------+-----------------------------------------------------+
| Value               | Meaning                                             |
+=====================+=====================================================+
| DEBUG_LEVBL_SUMMARY | 기본적인 함수 시작과 끝에 대한 메시지를 출력합니다. |
+---------------------+-----------------------------------------------------+
| DEBUG_LEVEL_DETAIL  | 함수의 매개변수를 포함한 메시지를 출력합니다.       |
+---------------------+-----------------------------------------------------+
| DEBUG_LEVEL_DEBUG   | 라이브러리 인터페이스의 디버그 정보를 출력합니다.   |
+---------------------+-----------------------------------------------------+
| DEBUG_LEVEL_ALL     | 전체 디버그 메시지를 출력합니다.                    |
+---------------------+-----------------------------------------------------+

- nDebugType : 디버그 메시지를 표시할 방법을 설정합니다.


+---------------------+------------------------------------------------+
| Value               | Meaning                                        |
+=====================+================================================+
| DEBUG_OUT-WINDOW    | 윈도우 메세지로 디버그 메세지를 출력합니다.    |
+---------------------+------------------------------------------------+
| DEBUG_OUT_LOCALFILE | 디버그 메세지를 파일로 출력합니다.             |
+---------------------+------------------------------------------------+
| DEBUG_OUT_CONSOLE   | 디버그 메세지를 콘솔창을 통해서 출력합니다.    |
+---------------------+------------------------------------------------+
| DEBUG_OUT_SOCKET    | 디버그 메세지를 TCP/UDP를 통해서 출력합니다.   |
+---------------------+------------------------------------------------+
| DEBUG_OUT_CALLBACK  | 디버그 메세지를 콜백 함수를 통해서 출력합니다. |
+---------------------+------------------------------------------------+




- Handler : 콜백 함수를 호출하기 위한 핸들러입니다. VT_EMPTY (pDebugHandler) (LPVOID) 형의 함수 포인터를 대입합니다.

- lParam : 콜백 함수를 호출할 때 파라미터에 넣어줄 값입니다.
 
- szDebugFileName : 파일로 디버그 메시지를 저장할 경우 지정하는 파일명입니다.

RETURN VALUE
`````````````
+-------------+-------------------------------------------------------+
| Value       | Meaning                                               |
+=============+=======================================================+
| 음수        | 수행 실패. 자세한 내용은 '에러 코드' 편을 참고합니다. |
+-------------+-------------------------------------------------------+
| cmnERR_NONE | 수행 성공                                             |
+-------------+-------------------------------------------------------+